DOC: Add documentation for pandas.api.typing.Expression (#63084) #63090
Conversation
pranavkp71
force-pushed
the
doc/add-expression-reference
branch
from
d99d850 to
235e127
Compare
rhshadrach
left a comment
rhshadrach
left a comment
There was a problem hiding this comment.
Thanks for the PR! We generally do not have documentation pages for classes that users are not supposed to instantiate directly (e.g. DataFrameGroupBy). I think this would need some discussion if we are going to add such pages.
| @@ -0,0 +1,33 @@ | |||
| pandas.API.typing.expression | |||
There was a problem hiding this comment.
The API documentation is generated from docstrings, not added as files here directly.
There was a problem hiding this comment.
You mean I should move this documentation into the Expression class docstring and remove the separate .rst page, index entry, correct?
There was a problem hiding this comment.
We'd also need to add the Expression class to one of the API doc pages, yes. But as indicated in #63084 (comment), this might be opposed by others on the core team. I think we should ensure the core team is aligned here before moving forward.
|
|
||
| **Description** | ||
|
|
||
| An ``Expression`` represents a symbolic reference to a DataFrame column. |
There was a problem hiding this comment.
This is false, pd.col("a") + 5 is not a reference to a column, but it is an expression.
| - Arithmetic: ``+``, ``-``, ``*``, ``/`` | ||
| - Comparison: ``<``, ``>``, ``==``, ``!=`` | ||
| - Universal functions (ufuncs): can be applied directly | ||
| - Series accessors: ``.dt``, ``.str``, ``.cat`` | ||
| - Series methods: ``.sum()``, ``.mean()``, ``.astype()``, etc. |
There was a problem hiding this comment.
We should generate the methods that an expression supports when building the API docs, not hardcode them.
| @@ -0,0 +1,33 @@ | |||
| pandas.API.typing.expression | |||
There was a problem hiding this comment.
We'd also need to add the Expression class to one of the API doc pages, yes. But as indicated in #63084 (comment), this might be opposed by others on the core team. I think we should ensure the core team is aligned here before moving forward.
2 participants
pd.colExpression objects #63084pandas.api.typing.Expression.This PR adds missing documentation for the
Expressionclass used bypd.col().The page includes:
DataFrame.assignAlso linked this page in the API reference index so it appears in the built documentation.